<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: AnnotationScanner.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.util;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.google.common.base.Function;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import com.google.common.collect.Lists;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import com.google.common.reflect.TypeToken;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.lang.annotation.Annotation;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.lang.reflect.Method;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import java.lang.reflect.Modifier;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import java.lang.reflect.Type;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import java.util.Arrays;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.List;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.dellroad.stuff.java.MethodAnnotationScanner;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.jsimpledb.JClass;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * Support superclass for Java model class annotation scanners.<a name="line.25"></a>
<span class="sourceLineNo">026</span> */<a name="line.26"></a>
<span class="sourceLineNo">027</span>public abstract class AnnotationScanner&lt;T, A extends Annotation&gt; extends MethodAnnotationScanner&lt;T, A&gt; {<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>    /**<a name="line.29"></a>
<span class="sourceLineNo">030</span>     * The associated Java model class, if any.<a name="line.30"></a>
<span class="sourceLineNo">031</span>     */<a name="line.31"></a>
<span class="sourceLineNo">032</span>    protected final JClass&lt;T&gt; jclass;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    /**<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * Constructor for when there is an associated {@link JClass}.<a name="line.35"></a>
<span class="sourceLineNo">036</span>     *<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * @param jclass Java model class<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * @param annotationType annotation to scan for<a name="line.38"></a>
<span class="sourceLineNo">039</span>     */<a name="line.39"></a>
<span class="sourceLineNo">040</span>    protected AnnotationScanner(JClass&lt;T&gt; jclass, Class&lt;A&gt; annotationType) {<a name="line.40"></a>
<span class="sourceLineNo">041</span>        super(jclass.getType(), annotationType);<a name="line.41"></a>
<span class="sourceLineNo">042</span>        this.jclass = jclass;<a name="line.42"></a>
<span class="sourceLineNo">043</span>    }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>    /**<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * Constructor for when there is no associated {@link JClass}.<a name="line.46"></a>
<span class="sourceLineNo">047</span>     *<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * @param type Java type to scan<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * @param annotationType annotation to scan for<a name="line.49"></a>
<span class="sourceLineNo">050</span>     */<a name="line.50"></a>
<span class="sourceLineNo">051</span>    @SuppressWarnings("unchecked")<a name="line.51"></a>
<span class="sourceLineNo">052</span>    protected AnnotationScanner(Class&lt;T&gt; type, Class&lt;A&gt; annotationType) {<a name="line.52"></a>
<span class="sourceLineNo">053</span>        super(type, annotationType);<a name="line.53"></a>
<span class="sourceLineNo">054</span>        this.jclass = null;<a name="line.54"></a>
<span class="sourceLineNo">055</span>    }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span>    /**<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * Get a simple description of the annotation being scanned for.<a name="line.58"></a>
<span class="sourceLineNo">059</span>     *<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * @return annotation description<a name="line.60"></a>
<span class="sourceLineNo">061</span>     */<a name="line.61"></a>
<span class="sourceLineNo">062</span>    public String getAnnotationDescription() {<a name="line.62"></a>
<span class="sourceLineNo">063</span>        return "@" + this.annotationType.getSimpleName();<a name="line.63"></a>
<span class="sourceLineNo">064</span>    }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    /**<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * Verify method is not static.<a name="line.67"></a>
<span class="sourceLineNo">068</span>     *<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * @param method the method to check<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * @throws IllegalArgumentException if method is static<a name="line.70"></a>
<span class="sourceLineNo">071</span>     */<a name="line.71"></a>
<span class="sourceLineNo">072</span>    protected void checkNotStatic(Method method) {<a name="line.72"></a>
<span class="sourceLineNo">073</span>        if ((method.getModifiers() &amp; Modifier.STATIC) != 0)<a name="line.73"></a>
<span class="sourceLineNo">074</span>            throw new IllegalArgumentException(this.getErrorPrefix(method) + "annotation is not supported on static methods");<a name="line.74"></a>
<span class="sourceLineNo">075</span>    }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    /**<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * Verify method return type.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param method the method to check<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @param expecteds allowed return types<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @throws IllegalArgumentException if has an invalid return type<a name="line.82"></a>
<span class="sourceLineNo">083</span>     */<a name="line.83"></a>
<span class="sourceLineNo">084</span>    protected void checkReturnType(Method method, List&lt;TypeToken&lt;?&gt;&gt; expecteds) {<a name="line.84"></a>
<span class="sourceLineNo">085</span>        final TypeToken&lt;?&gt; actual = TypeToken.of(method.getGenericReturnType());<a name="line.85"></a>
<span class="sourceLineNo">086</span>        for (TypeToken&lt;?&gt; expected : expecteds) {<a name="line.86"></a>
<span class="sourceLineNo">087</span>            if (actual.equals(expected))<a name="line.87"></a>
<span class="sourceLineNo">088</span>                return;<a name="line.88"></a>
<span class="sourceLineNo">089</span>        }<a name="line.89"></a>
<span class="sourceLineNo">090</span>        throw new IllegalArgumentException(this.getErrorPrefix(method) + "method is required to return "<a name="line.90"></a>
<span class="sourceLineNo">091</span>          + (expecteds.size() != 1 ? "one of " + expecteds : expecteds.get(0)) + " but instead returns " + actual);<a name="line.91"></a>
<span class="sourceLineNo">092</span>    }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span>    /**<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * Verify method return type.<a name="line.95"></a>
<span class="sourceLineNo">096</span>     *<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * @param method the method to check<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @param expecteds allowed return types<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * @throws IllegalArgumentException if has an invalid return type<a name="line.99"></a>
<span class="sourceLineNo">100</span>     */<a name="line.100"></a>
<span class="sourceLineNo">101</span>    protected void checkReturnType(Method method, Class&lt;?&gt;... expecteds) {<a name="line.101"></a>
<span class="sourceLineNo">102</span>        final Class&lt;?&gt; actual = method.getReturnType();<a name="line.102"></a>
<span class="sourceLineNo">103</span>        for (Class&lt;?&gt; expected : expecteds) {<a name="line.103"></a>
<span class="sourceLineNo">104</span>            if (actual.equals(expected))<a name="line.104"></a>
<span class="sourceLineNo">105</span>                return;<a name="line.105"></a>
<span class="sourceLineNo">106</span>        }<a name="line.106"></a>
<span class="sourceLineNo">107</span>        throw new IllegalArgumentException(this.getErrorPrefix(method) + "method is required to return "<a name="line.107"></a>
<span class="sourceLineNo">108</span>          + (expecteds.length != 1 ? "one of " + Arrays.asList(expecteds) : expecteds[0]) + " but instead returns " + actual);<a name="line.108"></a>
<span class="sourceLineNo">109</span>    }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span>    /**<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * Verify method parameter type(s).<a name="line.112"></a>
<span class="sourceLineNo">113</span>     *<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @param method the method to check<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * @param expected expected parameter types<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * @throws IllegalArgumentException if has an invalid parameter type(s)<a name="line.116"></a>
<span class="sourceLineNo">117</span>     */<a name="line.117"></a>
<span class="sourceLineNo">118</span>    protected void checkParameterTypes(Method method, List&lt;TypeToken&lt;?&gt;&gt; expected) {<a name="line.118"></a>
<span class="sourceLineNo">119</span>        final List&lt;TypeToken&lt;?&gt;&gt; actual = this.getParameterTypeTokens(method);<a name="line.119"></a>
<span class="sourceLineNo">120</span>        if (!actual.equals(expected)) {<a name="line.120"></a>
<span class="sourceLineNo">121</span>            throw new IllegalArgumentException(this.getErrorPrefix(method) + "method is required to take "<a name="line.121"></a>
<span class="sourceLineNo">122</span>              + (expected.isEmpty() ? "zero parameters" : expected.size() + " parameter(s) of type " + expected));<a name="line.122"></a>
<span class="sourceLineNo">123</span>        }<a name="line.123"></a>
<span class="sourceLineNo">124</span>    }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span>    /**<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * Verify method parameter type(s).<a name="line.127"></a>
<span class="sourceLineNo">128</span>     *<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * @param method the method to check<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * @param expected expected parameter types<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * @throws IllegalArgumentException if has an invalid parameter type(s)<a name="line.131"></a>
<span class="sourceLineNo">132</span>     */<a name="line.132"></a>
<span class="sourceLineNo">133</span>    protected void checkParameterTypes(Method method, TypeToken&lt;?&gt;... expected) {<a name="line.133"></a>
<span class="sourceLineNo">134</span>        this.checkParameterTypes(method, Arrays.asList(expected));<a name="line.134"></a>
<span class="sourceLineNo">135</span>    }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>    /**<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * Verify a specific method parameter's type.<a name="line.138"></a>
<span class="sourceLineNo">139</span>     *<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * @param method the method to check<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * @param index parameter index<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * @param choices allowed parameter types<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * @throws IllegalArgumentException if parameter type does not match<a name="line.143"></a>
<span class="sourceLineNo">144</span>     */<a name="line.144"></a>
<span class="sourceLineNo">145</span>    protected void checkParameterType(Method method, int index, List&lt;TypeToken&lt;?&gt;&gt; choices) {<a name="line.145"></a>
<span class="sourceLineNo">146</span>        final List&lt;TypeToken&lt;?&gt;&gt; actuals = this.getParameterTypeTokens(method);<a name="line.146"></a>
<span class="sourceLineNo">147</span>        if (actuals.size() &lt;= index || !choices.contains(actuals.get(index))) {<a name="line.147"></a>
<span class="sourceLineNo">148</span>            throw new IllegalArgumentException(this.getErrorPrefix(method) + "method parameter #" + (index + 1)<a name="line.148"></a>
<span class="sourceLineNo">149</span>              + " is required to have type " + (choices.size() != 1 ? "one of " + choices : choices.get(0)));<a name="line.149"></a>
<span class="sourceLineNo">150</span>        }<a name="line.150"></a>
<span class="sourceLineNo">151</span>    }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span>    /**<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * Verify a specific method parameter's type.<a name="line.154"></a>
<span class="sourceLineNo">155</span>     *<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * @param method the method to check<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * @param index parameter index<a name="line.157"></a>
<span class="sourceLineNo">158</span>     * @param choices allowed parameter types<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * @throws IllegalArgumentException if parameter type does not match<a name="line.159"></a>
<span class="sourceLineNo">160</span>     */<a name="line.160"></a>
<span class="sourceLineNo">161</span>    protected void checkParameterType(Method method, int index, TypeToken&lt;?&gt;... choices) {<a name="line.161"></a>
<span class="sourceLineNo">162</span>        this.checkParameterType(method, index, Arrays.asList(choices));<a name="line.162"></a>
<span class="sourceLineNo">163</span>    }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span>    /**<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * Verify method takes a single parameter of the specified type.<a name="line.166"></a>
<span class="sourceLineNo">167</span>     *<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * @param method the method to check<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * @param choices allowed parameter types<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * @throws IllegalArgumentException if parameter type does not match<a name="line.170"></a>
<span class="sourceLineNo">171</span>     */<a name="line.171"></a>
<span class="sourceLineNo">172</span>    protected void checkSingleParameterType(Method method, List&lt;TypeToken&lt;?&gt;&gt; choices) {<a name="line.172"></a>
<span class="sourceLineNo">173</span>        final List&lt;TypeToken&lt;?&gt;&gt; actuals = this.getParameterTypeTokens(method);<a name="line.173"></a>
<span class="sourceLineNo">174</span>        if (actuals.size() != 1 || !choices.contains(actuals.get(0))) {<a name="line.174"></a>
<span class="sourceLineNo">175</span>            throw new IllegalArgumentException(this.getErrorPrefix(method) + "method is required to take a single parameter"<a name="line.175"></a>
<span class="sourceLineNo">176</span>              + " with type " + (choices.size() != 1 ? "one of " + choices : choices.get(0)));<a name="line.176"></a>
<span class="sourceLineNo">177</span>        }<a name="line.177"></a>
<span class="sourceLineNo">178</span>    }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span>    /**<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * Get method parameter types as {@link TypeToken}s.<a name="line.181"></a>
<span class="sourceLineNo">182</span>     *<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * @param method the method to check<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * @return method parameter types<a name="line.184"></a>
<span class="sourceLineNo">185</span>     */<a name="line.185"></a>
<span class="sourceLineNo">186</span>    protected List&lt;TypeToken&lt;?&gt;&gt; getParameterTypeTokens(Method method) {<a name="line.186"></a>
<span class="sourceLineNo">187</span>        return Lists.transform(Arrays.asList(method.getGenericParameterTypes()), new Function&lt;Type, TypeToken&lt;?&gt;&gt;() {<a name="line.187"></a>
<span class="sourceLineNo">188</span>            @Override<a name="line.188"></a>
<span class="sourceLineNo">189</span>            public TypeToken&lt;?&gt; apply(Type type) {<a name="line.189"></a>
<span class="sourceLineNo">190</span>                return TypeToken.of(type);<a name="line.190"></a>
<span class="sourceLineNo">191</span>            }<a name="line.191"></a>
<span class="sourceLineNo">192</span>        });<a name="line.192"></a>
<span class="sourceLineNo">193</span>    }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span>    /**<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * Get "invalid annotation" error message prefix that describes the annotation on the specified method.<a name="line.196"></a>
<span class="sourceLineNo">197</span>     *<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * @param method the method to check<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * @return error message prefix<a name="line.199"></a>
<span class="sourceLineNo">200</span>     */<a name="line.200"></a>
<span class="sourceLineNo">201</span>    protected String getErrorPrefix(Method method) {<a name="line.201"></a>
<span class="sourceLineNo">202</span>        return "invalid " + this.getAnnotationDescription() + " annotation on method " + method<a name="line.202"></a>
<span class="sourceLineNo">203</span>          + " for type `" + this.jclass.getName() + "': ";<a name="line.203"></a>
<span class="sourceLineNo">204</span>    }<a name="line.204"></a>
<span class="sourceLineNo">205</span>}<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>




























































</pre>
</div>
</body>
</html>
